3 * Implements Special:Import
5 * Copyright © 2003,2005 Brion Vibber <brion@pobox.com>
6 * https://www.mediawiki.org/
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
24 * @ingroup SpecialPage
28 * MediaWiki page data importer
30 * @ingroup SpecialPage
32 class SpecialImport
extends SpecialPage
{
33 private $interwiki = false;
35 private $rootpage = '';
36 private $frompage = '';
37 private $logcomment = false;
38 private $history = true;
39 private $includeTemplates = false;
40 private $pageLinkDepth;
45 public function __construct() {
46 parent
::__construct( 'Import', 'import' );
47 $this->namespace = $this->getConfig()->get( 'ImportTargetNamespace' );
52 * @param string|null $par
54 function execute( $par ) {
56 $this->outputHeader();
58 $user = $this->getUser();
59 if ( !$user->isAllowedAny( 'import', 'importupload' ) ) {
60 throw new PermissionsError( 'import' );
63 # @todo Allow Title::getUserPermissionsErrors() to take an array
64 # @todo FIXME: Title::checkSpecialsAndNSPermissions() has a very wierd expectation of what
65 # getUserPermissionsErrors() might actually be used for, hence the 'ns-specialprotected'
66 $errors = wfMergeErrorArrays(
67 $this->getPageTitle()->getUserPermissionsErrors(
68 'import', $user, true,
69 array( 'ns-specialprotected', 'badaccess-group0', 'badaccess-groups' )
71 $this->getPageTitle()->getUserPermissionsErrors(
72 'importupload', $user, true,
73 array( 'ns-specialprotected', 'badaccess-group0', 'badaccess-groups' )
78 throw new PermissionsError( 'import', $errors );
81 $this->checkReadOnly();
83 $request = $this->getRequest();
84 if ( $request->wasPosted() && $request->getVal( 'action' ) == 'submit' ) {
91 * Do the actual import
93 private function doImport() {
95 $request = $this->getRequest();
96 $this->namespace = $request->getIntOrNull( 'namespace' );
97 $sourceName = $request->getVal( "source" );
99 $this->logcomment
= $request->getText( 'log-comment' );
100 $this->pageLinkDepth
= $this->getConfig()->get( 'ExportMaxLinkDepth' ) == 0
102 : $request->getIntOrNull( 'pagelink-depth' );
103 $this->rootpage
= $request->getText( 'rootpage' );
105 $user = $this->getUser();
106 if ( !$user->matchEditToken( $request->getVal( 'editToken' ) ) ) {
107 $source = Status
::newFatal( 'import-token-mismatch' );
108 } elseif ( $sourceName == 'upload' ) {
110 if ( $user->isAllowed( 'importupload' ) ) {
111 $source = ImportStreamSource
::newFromUpload( "xmlimport" );
113 throw new PermissionsError( 'importupload' );
115 } elseif ( $sourceName == "interwiki" ) {
116 if ( !$user->isAllowed( 'import' ) ) {
117 throw new PermissionsError( 'import' );
119 $this->interwiki
= $request->getVal( 'interwiki' );
120 if ( !in_array( $this->interwiki
, $this->getConfig()->get( 'ImportSources' ) ) ) {
121 $source = Status
::newFatal( "import-invalid-interwiki" );
123 $this->history
= $request->getCheck( 'interwikiHistory' );
124 $this->frompage
= $request->getText( "frompage" );
125 $this->includeTemplates
= $request->getCheck( 'interwikiTemplates' );
126 $source = ImportStreamSource
::newFromInterwiki(
130 $this->includeTemplates
,
131 $this->pageLinkDepth
);
134 $source = Status
::newFatal( "importunknownsource" );
137 $out = $this->getOutput();
138 if ( !$source->isGood() ) {
140 "<p class=\"error\">\n$1\n</p>",
141 array( 'importfailed', $source->getWikiText() )
144 $importer = new WikiImporter( $source->value
);
145 if ( !is_null( $this->namespace ) ) {
146 $importer->setTargetNamespace( $this->namespace );
148 if ( !is_null( $this->rootpage
) ) {
149 $statusRootPage = $importer->setTargetRootPage( $this->rootpage
);
150 if ( !$statusRootPage->isGood() ) {
152 "<p class=\"error\">\n$1\n</p>",
154 'import-options-wrong',
155 $statusRootPage->getWikiText(),
156 count( $statusRootPage->getErrorsArray() )
164 $out->addWikiMsg( "importstart" );
166 $reporter = new ImportReporter(
172 $reporter->setContext( $this->getContext() );
177 $importer->doImport();
178 } catch ( MWException
$e ) {
181 $result = $reporter->close();
184 # No source or XML parse error
186 "<p class=\"error\">\n$1\n</p>",
187 array( 'importfailed', $exception->getMessage() )
189 } elseif ( !$result->isGood() ) {
192 "<p class=\"error\">\n$1\n</p>",
193 array( 'importfailed', $result->getWikiText() )
197 $out->addWikiMsg( 'importsuccess' );
199 $out->addHTML( '<hr />' );
203 private function showForm() {
204 $action = $this->getPageTitle()->getLocalURL( array( 'action' => 'submit' ) );
205 $user = $this->getUser();
206 $out = $this->getOutput();
207 $importSources = $this->getConfig()->get( 'ImportSources' );
209 if ( $user->isAllowed( 'importupload' ) ) {
211 Xml
::fieldset( $this->msg( 'import-upload' )->text() ) .
215 'enctype' => 'multipart/form-data',
218 'id' => 'mw-import-upload-form'
221 $this->msg( 'importtext' )->parseAsBlock() .
222 Html
::hidden( 'action', 'submit' ) .
223 Html
::hidden( 'source', 'upload' ) .
224 Xml
::openElement( 'table', array( 'id' => 'mw-import-table-upload' ) ) .
226 <td class='mw-label'>" .
227 Xml
::label( $this->msg( 'import-upload-filename' )->text(), 'xmlimport' ) .
229 <td class='mw-input'>" .
230 Html
::input( 'xmlimport', '', 'file', array( 'id' => 'xmlimport' ) ) . ' ' .
234 <td class='mw-label'>" .
235 Xml
::label( $this->msg( 'import-comment' )->text(), 'mw-import-comment' ) .
237 <td class='mw-input'>" .
238 Xml
::input( 'log-comment', 50, '',
239 array( 'id' => 'mw-import-comment', 'type' => 'text' ) ) . ' ' .
243 <td class='mw-label'>" .
245 $this->msg( 'import-interwiki-rootpage' )->text(),
246 'mw-interwiki-rootpage-upload'
249 <td class='mw-input'>" .
250 Xml
::input( 'rootpage', 50, $this->rootpage
,
251 array( 'id' => 'mw-interwiki-rootpage-upload', 'type' => 'text' ) ) . ' ' .
256 <td class='mw-submit'>" .
257 Xml
::submitButton( $this->msg( 'uploadbtn' )->text() ) .
260 Xml
::closeElement( 'table' ) .
261 Html
::hidden( 'editToken', $user->getEditToken() ) .
262 Xml
::closeElement( 'form' ) .
263 Xml
::closeElement( 'fieldset' )
266 if ( empty( $importSources ) ) {
267 $out->addWikiMsg( 'importnosources' );
271 if ( $user->isAllowed( 'import' ) && !empty( $importSources ) ) {
272 # Show input field for import depth only if $wgExportMaxLinkDepth > 0
274 if ( $this->getConfig()->get( 'ExportMaxLinkDepth' ) > 0 ) {
276 <td class='mw-label'>" .
277 $this->msg( 'export-pagelinks' )->parse() .
279 <td class='mw-input'>" .
280 Xml
::input( 'pagelink-depth', 3, 0 ) .
286 Xml
::fieldset( $this->msg( 'importinterwiki' )->text() ) .
292 'id' => 'mw-import-interwiki-form'
295 $this->msg( 'import-interwiki-text' )->parseAsBlock() .
296 Html
::hidden( 'action', 'submit' ) .
297 Html
::hidden( 'source', 'interwiki' ) .
298 Html
::hidden( 'editToken', $user->getEditToken() ) .
299 Xml
::openElement( 'table', array( 'id' => 'mw-import-table-interwiki' ) ) .
301 <td class='mw-label'>" .
302 Xml
::label( $this->msg( 'import-interwiki-source' )->text(), 'interwiki' ) .
304 <td class='mw-input'>" .
307 array( 'name' => 'interwiki', 'id' => 'interwiki' )
311 foreach ( $importSources as $prefix ) {
312 $selected = ( $this->interwiki
=== $prefix ) ?
' selected="selected"' : '';
313 $out->addHTML( Xml
::option( $prefix, $prefix, $selected ) );
317 Xml
::closeElement( 'select' ) .
318 Xml
::input( 'frompage', 50, $this->frompage
, array( 'id' => 'frompage' ) ) .
324 <td class='mw-input'>" .
326 $this->msg( 'import-interwiki-history' )->text(),
336 <td class='mw-input'>" .
338 $this->msg( 'import-interwiki-templates' )->text(),
339 'interwikiTemplates',
340 'interwikiTemplates',
341 $this->includeTemplates
347 <td class='mw-label'>" .
348 Xml
::label( $this->msg( 'import-interwiki-namespace' )->text(), 'namespace' ) .
350 <td class='mw-input'>" .
351 Html
::namespaceSelector(
353 'selected' => $this->namespace,
356 'name' => 'namespace',
358 'class' => 'namespaceselector',
364 <td class='mw-label'>" .
365 Xml
::label( $this->msg( 'import-comment' )->text(), 'mw-interwiki-comment' ) .
367 <td class='mw-input'>" .
368 Xml
::input( 'log-comment', 50, '',
369 array( 'id' => 'mw-interwiki-comment', 'type' => 'text' ) ) . ' ' .
373 <td class='mw-label'>" .
375 $this->msg( 'import-interwiki-rootpage' )->text(),
376 'mw-interwiki-rootpage-interwiki'
379 <td class='mw-input'>" .
380 Xml
::input( 'rootpage', 50, $this->rootpage
,
381 array( 'id' => 'mw-interwiki-rootpage-interwiki', 'type' => 'text' ) ) . ' ' .
387 <td class='mw-submit'>" .
389 $this->msg( 'import-interwiki-submit' )->text(),
390 Linker
::tooltipAndAccesskeyAttribs( 'import' )
394 Xml
::closeElement( 'table' ) .
395 Xml
::closeElement( 'form' ) .
396 Xml
::closeElement( 'fieldset' )
401 protected function getGroupName() {
408 * @ingroup SpecialPage
410 class ImportReporter
extends ContextSource
{
411 private $reason = false;
412 private $mOriginalLogCallback = null;
413 private $mOriginalPageOutCallback = null;
414 private $mLogItemCount = 0;
417 * @param WikiImporter $importer
418 * @param bool $upload
419 * @param string $interwiki
420 * @param string|bool $reason
422 function __construct( $importer, $upload, $interwiki, $reason = false ) {
423 $this->mOriginalPageOutCallback
=
424 $importer->setPageOutCallback( array( $this, 'reportPage' ) );
425 $this->mOriginalLogCallback
=
426 $importer->setLogItemCallback( array( $this, 'reportLogItem' ) );
427 $importer->setNoticeCallback( array( $this, 'reportNotice' ) );
428 $this->mPageCount
= 0;
429 $this->mIsUpload
= $upload;
430 $this->mInterwiki
= $interwiki;
431 $this->reason
= $reason;
435 $this->getOutput()->addHTML( "<ul>\n" );
438 function reportNotice( $msg, array $params ) {
439 $this->getOutput()->addHTML(
440 Html
::element( 'li', array(), $this->msg( $msg, $params )->text() )
444 function reportLogItem( /* ... */ ) {
445 $this->mLogItemCount++
;
446 if ( is_callable( $this->mOriginalLogCallback
) ) {
447 call_user_func_array( $this->mOriginalLogCallback
, func_get_args() );
452 * @param Title $title
453 * @param Title $origTitle
454 * @param int $revisionCount
455 * @param int $successCount
456 * @param array $pageInfo
459 function reportPage( $title, $origTitle, $revisionCount, $successCount, $pageInfo ) {
460 $args = func_get_args();
461 call_user_func_array( $this->mOriginalPageOutCallback
, $args );
463 if ( $title === null ) {
464 # Invalid or non-importable title; a notice is already displayed
470 if ( $successCount > 0 ) {
471 $this->getOutput()->addHTML(
472 "<li>" . Linker
::linkKnown( $title ) . " " .
473 $this->msg( 'import-revision-count' )->numParams( $successCount )->escaped() .
477 $log = new LogPage( 'import' );
478 if ( $this->mIsUpload
) {
479 $detail = $this->msg( 'import-logentry-upload-detail' )->numParams(
480 $successCount )->inContentLanguage()->text();
481 if ( $this->reason
) {
482 $detail .= $this->msg( 'colon-separator' )->inContentLanguage()->text()
485 $log->addEntry( 'upload', $title, $detail, array(), $this->getUser() );
487 $interwiki = '[[:' . $this->mInterwiki
. ':' .
488 $origTitle->getPrefixedText() . ']]';
489 $detail = $this->msg( 'import-logentry-interwiki-detail' )->numParams(
490 $successCount )->params( $interwiki )->inContentLanguage()->text();
491 if ( $this->reason
) {
492 $detail .= $this->msg( 'colon-separator' )->inContentLanguage()->text()
495 $log->addEntry( 'interwiki', $title, $detail, array(), $this->getUser() );
498 $comment = $detail; // quick
499 $dbw = wfGetDB( DB_MASTER
);
500 $latest = $title->getLatestRevID();
501 $nullRevision = Revision
::newNullRevision(
503 $title->getArticleID(),
509 if ( !is_null( $nullRevision ) ) {
510 $nullRevision->insertOn( $dbw );
511 $page = WikiPage
::factory( $title );
513 $page->updateRevisionOn( $dbw, $nullRevision );
515 'NewRevisionFromEditComplete',
516 array( $page, $nullRevision, $latest, $this->getUser() )
520 $this->getOutput()->addHTML( "<li>" . Linker
::linkKnown( $title ) . " " .
521 $this->msg( 'import-nonewrevisions' )->escaped() . "</li>\n" );
526 $out = $this->getOutput();
527 if ( $this->mLogItemCount
> 0 ) {
528 $msg = $this->msg( 'imported-log-entries' )->numParams( $this->mLogItemCount
)->parse();
529 $out->addHTML( Xml
::tags( 'li', null, $msg ) );
530 } elseif ( $this->mPageCount
== 0 && $this->mLogItemCount
== 0 ) {
531 $out->addHTML( "</ul>\n" );
533 return Status
::newFatal( 'importnopages' );
535 $out->addHTML( "</ul>\n" );
537 return Status
::newGood( $this->mPageCount
);